Prepare 1.0.0: branding, GitHub metadata, and release automation#22
Merged
Conversation
…tion Version & docs: - Cut CHANGELOG 1.0.0 (2026-06-29); drop accreted pre-release history - Bump version references to 1.0.0; default to 1.0.0-SNAPSHOT - README: dual Java & Kotlin branding, shields, Features, v1.0 title - POM: Java & Kotlin name/description, docs-site project URL, GitHub issue tracker; finalize Install section GitHub repo metadata (adapted from sdk-php): - Issue templates (bug.yml + config.yml) with Java/Kotlin + build-tool fields - FUNDING.yml, dependabot.yml (gradle), dependabot-auto-merge - BUG_FINDING / ISSUE_WORKFLOW / RELEASE_PROCESS process docs Release automation: - tag-and-release.yml: gated JDK matrix → tag + GitHub Release, chaining into Maven Central by default (publish_to_central toggle) - publish.yml: reusable via workflow_call; harden version interpolation - update-changelog.yml on published release
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #22 +/- ##
============================================
- Coverage 98.32% 98.27% -0.06%
+ Complexity 1073 1043 -30
============================================
Files 128 123 -5
Lines 2692 2606 -86
Branches 311 301 -10
============================================
- Hits 2647 2561 -86
Partials 45 45 see 9 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Pin stefanzweifel/changelog-updater-action (v1.12.0) and git-auto-commit-action (v7.2.0) to full commit SHAs to remove the mutable-tag supply-chain surface. Dependabot's github-actions ecosystem keeps the SHAs current via reviewed PRs.
Address PR review (MarketDataDev03): 1. Chained publish built github.sha (the launch commit), not the released ref. In workflow_call, github.sha is inherited from the caller's launch ref, and publish.yml checked out with no ref:. If tag-and-release was launched from a branch other than inputs.ref, the tag/Release pointed at inputs.ref but the immutable Maven Central jar was built from the launch commit. Fix: add a `ref` input to publish.yml used in both the guard (head_sha) and checkout; tag-and-release resolves inputs.ref to a concrete SHA, tags at that SHA, and passes it to publish-central. 2. update-changelog.yml (on: release) never fired: the release is cut with GITHUB_TOKEN, and GITHUB_TOKEN-created events don't trigger workflows — the same rule that motivated workflow_call for publish. It was also redundant: our process finalizes the CHANGELOG (dated section) before the tag, which the notes-extraction step requires. Fix: remove the workflow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
First stable release prep for the Market Data Java & Kotlin SDK. No SDK source/behavior changes — versioning, docs/branding, GitHub repo metadata, and release automation.
Version & release notes
## [1.0.0] - 2026-06-29entry; dropped accreted pre-release dev history; added Keep-a-Changelog compare links.0.1.0→1.0.0across README,docs/installation.md, examples; build default →1.0.0-SNAPSHOT(publish injects the real version via-PsdkVersion).Branding / README
v1.0, JVM blurb, Java + Kotlin badges, Kotlin promoted to lead Feature).name/descriptioncarry the Java & Kotlin branding; Project URL → docs site (/docs/sdk/java), new Issue Tracker (<issueManagement>); Source Control unchanged.GitHub repo metadata (adapted from
sdk-php)bug.yml(+ Language and Build-Tool dropdowns, JDK/Gradle/Maven fields) andconfig.yml.FUNDING.yml,dependabot.yml(gradle ecosystem),dependabot-auto-merge.yml.BUG_FINDING.md,ISSUE_WORKFLOW.md,RELEASE_PROCESS.md— fully translated to Gradle/JUnit/Java.Release automation
tag-and-release.yml(new): gated JDK {17,21,25} matrix → verify tag is new → extract CHANGELOG notes → tagvX.Y.Z+ GitHub Release, then chains into Maven Central by default (publish_to_centraltoggle to opt out).publish.yml: now reusable viaworkflow_call(kept manual dispatch);inputs.versionrouted throughenv:to remove shell-injection surface.update-changelog.yml(new): folds release notes back into CHANGELOG on published release.Chaining design note
Used
workflow_callrather than anon: releasetrigger because a release created with the defaultGITHUB_TOKENdoes not trigger downstream workflows —workflow_callkeeps it one deterministic run, no extra PAT.Verification
./gradlew build→ green at 1.0.0.generatePomFileForMavenPublication→ all External Resources resolve.gate → release → publish-central (if toggle).Not included
docs/architecture.md/docs/sdk-requirements.md— pre-existing untracked files, unrelated; left out.Heads-up
If the
maven-centralGitHub Environment has required reviewers, the chained publish will pause for approval rather than being fully hands-off.